www.gusucode.com > Piwik 网站流量统计系统 v2.9.1PHP源码程序 > Piwik 网站流量统计系统 v2.9.1/piwik/piwik/core/SettingsPiwik.php
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik;
use Exception;
/**
* Contains helper methods that can be used to get common Piwik settings.
*
*/
class SettingsPiwik
{
const OPTION_PIWIK_URL = 'piwikUrl';
/**
* Get salt from [General] section
*
* @return string
*/
public static function getSalt()
{
static $salt = null;
if (is_null($salt)) {
$salt = @Config::getInstance()->General['salt'];
}
return $salt;
}
/**
* Should Piwik check that the login & password have minimum length and valid characters?
*
* @return bool True if checks enabled; false otherwise
*/
public static function isUserCredentialsSanityCheckEnabled()
{
return Config::getInstance()->General['disable_checks_usernames_attributes'] == 0;
}
/**
* @see getKnownSegmentsToArchive
*
* @var array
*/
public static $cachedKnownSegmentsToArchive = null;
/**
* Returns every stored segment to pre-process for each site during cron archiving.
*
* @return array The list of stored segments that apply to all sites.
*/
public static function getKnownSegmentsToArchive()
{
if (self::$cachedKnownSegmentsToArchive === null) {
$segments = Config::getInstance()->Segments;
$segmentsToProcess = isset($segments['Segments']) ? $segments['Segments'] : array();
/**
* Triggered during the cron archiving process to collect segments that
* should be pre-processed for all websites. The archiving process will be launched
* for each of these segments when archiving data.
*
* This event can be used to add segments to be pre-processed. If your plugin depends
* on data from a specific segment, this event could be used to provide enhanced
* performance.
*
* _Note: If you just want to add a segment that is managed by the user, use the
* SegmentEditor API._
*
* **Example**
*
* Piwik::addAction('Segments.getKnownSegmentsToArchiveAllSites', function (&$segments) {
* $segments[] = 'country=jp;city=Tokyo';
* });
*
* @param array &$segmentsToProcess List of segment definitions, eg,
*
* array(
* 'browserCode=ff;resolution=800x600',
* 'country=jp;city=Tokyo'
* )
*
* Add segments to this array in your event handler.
*/
Piwik::postEvent('Segments.getKnownSegmentsToArchiveAllSites', array(&$segmentsToProcess));
self::$cachedKnownSegmentsToArchive = array_unique($segmentsToProcess);
}
return self::$cachedKnownSegmentsToArchive;
}
/**
* Returns the list of stored segments to pre-process for an individual site when executing
* cron archiving.
*
* @param int $idSite The ID of the site to get stored segments for.
* @return string The list of stored segments that apply to the requested site.
*/
public static function getKnownSegmentsToArchiveForSite($idSite)
{
$segments = array();
/**
* Triggered during the cron archiving process to collect segments that
* should be pre-processed for one specific site. The archiving process will be launched
* for each of these segments when archiving data for that one site.
*
* This event can be used to add segments to be pre-processed for one site.
*
* _Note: If you just want to add a segment that is managed by the user, you should use the
* SegmentEditor API._
*
* **Example**
*
* Piwik::addAction('Segments.getKnownSegmentsToArchiveForSite', function (&$segments, $idSite) {
* $segments[] = 'country=jp;city=Tokyo';
* });
*
* @param array &$segmentsToProcess List of segment definitions, eg,
*
* array(
* 'browserCode=ff;resolution=800x600',
* 'country=JP;city=Tokyo'
* )
*
* Add segments to this array in your event handler.
* @param int $idSite The ID of the site to get segments for.
*/
Piwik::postEvent('Segments.getKnownSegmentsToArchiveForSite', array(&$segments, $idSite));
return $segments;
}
/**
* Number of websites to show in the Website selector
*
* @return int
*/
public static function getWebsitesCountToDisplay()
{
$count = max(Config::getInstance()->General['site_selector_max_sites'],
Config::getInstance()->General['autocomplete_min_sites']);
return (int)$count;
}
/**
* Returns the URL to this Piwik instance, eg. **http://demo.piwik.org/** or **http://example.org/piwik/**.
*
* @return string
* @api
*/
public static function getPiwikUrl()
{
$url = Option::get(self::OPTION_PIWIK_URL);
$isPiwikCoreDispatching = defined('PIWIK_ENABLE_DISPATCH') && PIWIK_ENABLE_DISPATCH;
if (Common::isPhpCliMode()
// in case core:archive command is triggered (often with localhost domain)
|| SettingsServer::isArchivePhpTriggered()
// When someone else than core is dispatching this request then we return the URL as it is read only
|| !$isPiwikCoreDispatching
) {
return $url;
}
$currentUrl = Common::sanitizeInputValue(Url::getCurrentUrlWithoutFileName());
if (empty($url)
// if URL changes, always update the cache
|| $currentUrl != $url
) {
if (strlen($currentUrl) >= strlen('http://a/')) {
self::overwritePiwikUrl($currentUrl);
}
$url = $currentUrl;
}
if (ProxyHttp::isHttps()) {
$url = str_replace("http://", "https://", $url);
}
return $url;
}
/**
* Return true if Piwik is installed (installation is done).
* @return bool
*/
public static function isPiwikInstalled()
{
$config = Config::getInstance()->getLocalPath();
$exists = file_exists($config);
// Piwik is installed if the config file is found
if (!$exists) {
return false;
}
$general = Config::getInstance()->General;
$isInstallationInProgress = false;
if (array_key_exists('installation_in_progress', $general)) {
$isInstallationInProgress = (bool) $general['installation_in_progress'];
}
if ($isInstallationInProgress) {
return false;
}
// Check that the database section is really set, ie. file is not empty
if (empty(Config::getInstance()->database['username'])) {
return false;
}
return true;
}
/**
* Returns `true` if segmentation is allowed for this user, `false` if otherwise.
*
* @return bool
* @api
*/
public static function isSegmentationEnabled()
{
return !Piwik::isUserIsAnonymous()
|| Config::getInstance()->General['anonymous_user_enable_use_segments_API'];
}
/**
* Returns true if unique visitors should be processed for the given period type.
*
* Unique visitor processing is controlled by the `[General] enable_processing_unique_visitors_...`
* INI config options. By default, unique visitors are processed only for day/week/month periods.
*
* @param string $periodLabel `"day"`, `"week"`, `"month"`, `"year"` or `"range"`
* @return bool
* @api
*/
public static function isUniqueVisitorsEnabled($periodLabel)
{
$generalSettings = Config::getInstance()->General;
$settingName = "enable_processing_unique_visitors_$periodLabel";
$result = !empty($generalSettings[$settingName]) && $generalSettings[$settingName] == 1;
// check enable_processing_unique_visitors_year_and_range for backwards compatibility
if (($periodLabel == 'year' || $periodLabel == 'range')
&& isset($generalSettings['enable_processing_unique_visitors_year_and_range'])
) {
$result |= $generalSettings['enable_processing_unique_visitors_year_and_range'] == 1;
}
return $result;
}
/**
* @deprecated Use SettingsPiwik::rewriteTmpPathWithInstanceId instead
*/
public static function rewriteTmpPathWithHostname($path)
{
return self::rewriteTmpPathWithInstanceId($path);
}
/**
* If Piwik uses per-domain config file, also make tmp/ folder per-domain
* @param $path
* @return string
* @throws \Exception
*/
public static function rewriteTmpPathWithInstanceId($path)
{
$tmp = '/tmp/';
$path = self::rewritePathAppendPiwikInstanceId($path, $tmp);
return $path;
}
/**
* If Piwik uses per-domain config file, make sure CustomLogo is unique
* @param $path
* @return mixed
*/
public static function rewriteMiscUserPathWithInstanceId($path)
{
$tmp = 'misc/user/';
$path = self::rewritePathAppendPiwikInstanceId($path, $tmp);
return $path;
}
/**
* Returns true if the Piwik server appears to be working.
*
* If the Piwik server is in an error state (eg. some directories are not writable and Piwik displays error message),
* or if the Piwik server is "offline",
* this will return false..
*
* @param $piwikServerUrl
* @param bool $acceptInvalidSSLCertificates
* @throws Exception
* @return bool
*/
public static function checkPiwikServerWorking($piwikServerUrl, $acceptInvalidSSLCertificates = false)
{
// Now testing if the webserver is running
try {
$fetched = Http::sendHttpRequestBy('curl',
$piwikServerUrl,
$timeout = 45,
$userAgent = null,
$destinationPath = null,
$file = null,
$followDepth = 0,
$acceptLanguage = false,
$acceptInvalidSSLCertificates
);
} catch (Exception $e) {
$fetched = "ERROR fetching: " . $e->getMessage();
}
// this will match when Piwik not installed yet, or favicon not customised
$expectedStringAlt = 'plugins/CoreHome/images/favicon.ico';
// this will match when Piwik is installed and favicon has been customised
$expectedString = 'misc/user/';
$expectedStringNotFound = strpos($fetched, $expectedString) === false && strpos($fetched, $expectedStringAlt) === false;
$hasError = false !== strpos($fetched, PAGE_TITLE_WHEN_ERROR);
if ($hasError || $expectedStringNotFound) {
throw new Exception("\nPiwik should be running at: "
. $piwikServerUrl
. " but this URL returned an unexpected response: '"
. $fetched . "'\n\n");
}
}
/**
* Returns true if Piwik is deployed using git
* FAQ: http://piwik.org/faq/how-to-install/faq_18271/
*
* @return bool
*/
public static function isGitDeployment()
{
return file_exists(PIWIK_INCLUDE_PATH . '/.git/HEAD');
}
public static function getCurrentGitBranch()
{
$file = PIWIK_INCLUDE_PATH . '/.git/HEAD';
if (!file_exists($file)) {
return '';
}
$firstLineOfGitHead = file($file);
if (empty($firstLineOfGitHead)) {
return '';
}
$firstLineOfGitHead = $firstLineOfGitHead[0];
$parts = explode('/', $firstLineOfGitHead);
if (empty($parts[2])) {
return '';
}
$currentGitBranch = trim($parts[2]);
return $currentGitBranch;
}
/**
* @param $pathToRewrite
* @param $leadingPathToAppendHostnameTo
* @param $hostname
* @return mixed
* @throws \Exception
*/
protected static function rewritePathAppendPiwikInstanceId($pathToRewrite, $leadingPathToAppendHostnameTo)
{
$instanceId = self::getPiwikInstanceId();
if (empty($instanceId)) {
return $pathToRewrite;
}
if (($posTmp = strrpos($pathToRewrite, $leadingPathToAppendHostnameTo)) === false) {
throw new Exception("The path $pathToRewrite was expected to contain the string $leadingPathToAppendHostnameTo");
}
$tmpToReplace = $leadingPathToAppendHostnameTo . $instanceId . '/';
// replace only the latest occurrence (in case path contains twice /tmp)
$pathToRewrite = substr_replace($pathToRewrite, $tmpToReplace, $posTmp, strlen($leadingPathToAppendHostnameTo));
return $pathToRewrite;
}
/**
* @throws \Exception
* @return string or False if not set
*/
protected static function getPiwikInstanceId()
{
// until Piwik is installed, we use hostname as instance_id
if (!self::isPiwikInstalled()
&& Common::isPhpCliMode()) {
// enterprise:install use case
return Config::getHostname();
}
// config.ini.php not ready yet, instance_id will not be set
if (!Config::getInstance()->existsLocalConfig()) {
return false;
}
$instanceId = @Config::getInstance()->General['instance_id'];
if (!empty($instanceId)) {
return $instanceId;
}
// do not rewrite the path as Piwik uses the standard config.ini.php file
return false;
}
/**
* @param $currentUrl
*/
public static function overwritePiwikUrl($currentUrl)
{
Option::set(self::OPTION_PIWIK_URL, $currentUrl, $autoLoad = true);
}
/**
* @return bool
*/
public static function isHttpsForced()
{
return Config::getInstance()->General['force_ssl'] == 1;
}
}